nfc7spi.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef NFC7SPI_H
#define NFC7SPI_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"




#define NFC7SPI_NCI_PKT_MT_DATA                 0x00
#define NFC7SPI_NCI_PKT_MT_CTRL_CMD             0x01
#define NFC7SPI_NCI_PKT_MT_CTRL_RSP             0x02
#define NFC7SPI_NCI_PKT_MT_CTRL_NTF             0x03
#define NFC7SPI_NCI_PKT_MT_SHIFT                5
#define NFC7SPI_NCI_PKT_MT_MASK                 0xE0
#define NFC7SPI_NCI_PKT_PBF_COMPLETE            0x00
#define NFC7SPI_NCI_PKT_PBF_NOT_COMPLETE        0x01
#define NFC7SPI_NCI_PKT_PBF_SHIFT               4
#define NFC7SPI_NCI_PKT_PBF_MASK                0x10
#define NFC7SPI_NCI_PKT_CTRL_GID_MASK           0x0F
#define NFC7SPI_NCI_PKT_CTRL_OID_MASK           0x3F
#define NFC7SPI_NCI_PKT_DATA_CID_MASK           0x0F
#define NFC7SPI_NCI_PKT_DATA_RFU                0x00

#define NFC7SPI_NCI_GID_CORE                    0x00
#define NFC7SPI_NCI_GID_RF_MGMT                 0x01
#define NFC7SPI_NCI_GID_PROP                    0x0F

#define NFC7SPI_NCI_OID_CORE_RESET              0x00
#define NFC7SPI_NCI_OID_CORE_INIT               0x01
#define NFC7SPI_NCI_OID_CORE_SET_CONFIG         0x02
#define NFC7SPI_NCI_OID_CORE_GET_CONFIG         0x03
#define NFC7SPI_NCI_OID_CORE_CONN_CREATE        0x04
#define NFC7SPI_NCI_OID_CORE_CONN_CLOSE         0x05
#define NFC7SPI_NCI_OID_CORE_CONN_CREDITS       0x06
#define NFC7SPI_NCI_OID_CORE_GEN_ERR_STAT       0x07
#define NFC7SPI_NCI_OID_CORE_INTF_ERR_STAT      0x08
#define NFC7SPI_NCI_OID_RF_DISCOVER_MAP         0x00
#define NFC7SPI_NCI_OID_RF_SET_ROUTING          0x01
#define NFC7SPI_NCI_OID_RF_GET_ROUTING          0x02
#define NFC7SPI_NCI_OID_RF_DISCOVER             0x03
#define NFC7SPI_NCI_OID_RF_DISCOVER_SELECT      0x04
#define NFC7SPI_NCI_OID_RF_INTF_ACTIVATED       0x05
#define NFC7SPI_NCI_OID_RF_DEACTIVATE           0x06
#define NFC7SPI_NCI_OID_RF_FIELD                0x07
#define NFC7SPI_NCI_OID_RF_T3T_POLLING          0x08
#define NFC7SPI_NCI_OID_RF_EE_ACTION            0x09
#define NFC7SPI_NCI_OID_RF_EE_DISCOVERY_REQ     0x0A
#define NFC7SPI_NCI_OID_RF_PARAMETER_UPDATE     0x0B
#define NFC7SPI_NCI_OID_PROP_SET_PWR_MODE       0x00
#define NFC7SPI_NCI_OID_PROP_ACT                0x02
#define NFC7SPI_NCI_OID_PROP_RF_PRES_CHECK      0x11
#define NFC7SPI_NCI_OID_PROP_RF_LPCD_TRACE      0x13
#define NFC7SPI_NCI_OID_PROP_RF_GET_TRANSIT     0x14
#define NFC7SPI_NCI_OID_PROP_TEST_PRBS          0x30
#define NFC7SPI_NCI_OID_PROP_TEST_ANTENNA       0x3D
 // nfc7spi_reg



#define NFC7SPI_NCI_CORE_RESET_KEEP_CFG         0x00
#define NFC7SPI_NCI_CORE_RESET_RESET_CFG        0x01
#define NFC7SPI_NCI_CORE_RESET_NTF_NCI_VER_20   0x20
#define NFC7SPI_NCI_CORE_INIT_FEATURE_DIS       0x00
#define NFC7SPI_NCI_CORE_STANDBY_DISABLE        0x00
#define NFC7SPI_NCI_CORE_STANDBY_ENABLE         0x01
#define NFC7SPI_NCI_CORE_STANDBY_AUTO           0x02

#define NFC7SPI_NCI_STAT_OK                     0x00
#define NFC7SPI_NCI_STAT_REJECTED               0x01
#define NFC7SPI_NCI_STAT_RF_FRAME_CORRUPTED     0x02
#define NFC7SPI_NCI_STAT_FAILED                 0x03
#define NFC7SPI_NCI_STAT_NOT_INITIALIZED        0x04
#define NFC7SPI_NCI_STAT_SYNTAX_ERROR           0x05
#define NFC7SPI_NCI_STAT_SEMANTIC_ERROR         0x06
#define NFC7SPI_NCI_STAT_UNK_GID                0x07
#define NFC7SPI_NCI_STAT_UNK_OID                0x08
#define NFC7SPI_NCI_STAT_INVALID_PARAM          0x09
#define NFC7SPI_NCI_STAT_MSG_SIZE_EXCEEDED      0x0A
#define NFC7SPI_NCI_STAT_DISC_ALRDY_STARTED     0xA0
#define NFC7SPI_NCI_STAT_DISC_T_ACT_FAILED      0xA1
#define NFC7SPI_NCI_STAT_DISC_TEAR_DOWN         0xA2
#define NFC7SPI_NCI_STAT_RF_TX_ERROR            0xB0
#define NFC7SPI_NCI_STAT_RF_PROTOCOL_ERROR      0xB1
#define NFC7SPI_NCI_STAT_RF_TIMEOUT_ERROR       0xB2

#define NFC7SPI_NCI_RF_TECH_PASSIVE_POLL_NFC_A  0x00
#define NFC7SPI_NCI_RF_TECH_PASSIVE_POLL_NFC_B  0x01
#define NFC7SPI_NCI_RF_TECH_PASSIVE_POLL_NFC_F  0x02
#define NFC7SPI_NCI_RF_TECH_PASSIVE_POLL_15693  0x06
#define NFC7SPI_NCI_RF_EXE_EVERY_DISC_PERIOD    0x01

#define NFC7SPI_NCI_RF_PROT_UNDETERMINED        0x00
#define NFC7SPI_NCI_RF_PROT_T1T                 0x01
#define NFC7SPI_NCI_RF_PROT_T2T                 0x02
#define NFC7SPI_NCI_RF_PROT_T3T                 0x03
#define NFC7SPI_NCI_RF_PROT_ISODEP              0x04
#define NFC7SPI_NCI_RF_PROT_NFCDEP              0x05
#define NFC7SPI_NCI_RF_PROT_T5T                 0x06
#define NFC7SPI_NCI_RF_PROT_MIFARE              0x80

#define NFC7SPI_NCI_RF_INTF_UNDETERMINED        0x00
#define NFC7SPI_NCI_RF_INTF_FRAME               0x01
#define NFC7SPI_NCI_RF_INTF_ISODEP              0x02
#define NFC7SPI_NCI_RF_INTF_NFCDEP              0x03
#define NFC7SPI_NCI_RF_INTF_TAGCMD              0x80
#define NFC7SPI_NCI_RF_MAP_POLL_MODE            0x01

#define NFC7SPI_NCI_RF_DEACTIVATE_IDLE          0x00
#define NFC7SPI_NCI_RF_DEACTIVATE_SLEEP         0x01
#define NFC7SPI_NCI_RF_DEACTIVATE_SLEEP_AF      0x02
#define NFC7SPI_NCI_RF_DEACTIVATE_DISCOVERY     0x03

#define NFC7SPI_NCI_RF_CONN_ID_STATIC           0x00
#define NFC7SPI_NCI_RF_CONN_ID_1                0x01
#define NFC7SPI_NCI_RF_CONN_ID_2                0x02
#define NFC7SPI_NCI_RF_DISC_MORE_NTF_FOLLOW     0x02

#define NFC7SPI_T1T_CMD_RID                     0x78
#define NFC7SPI_T1T_CMD_RALL                    0x00
#define NFC7SPI_T1T_CMD_READ                    0x01
#define NFC7SPI_T1T_CMD_WRITE_E                 0x53
#define NFC7SPI_T1T_CMD_WRITE_NE                0x1A
#define NFC7SPI_T1T_CMD_RSEG                    0x10
#define NFC7SPI_T1T_CMD_READ8                   0x02
#define NFC7SPI_T1T_CMD_WRITE_E8                0x54
#define NFC7SPI_T1T_CMD_WRITE_NE8               0x1B

#define NFC7SPI_T2T_CMD_READ                    0x30
#define NFC7SPI_T2T_CMD_WRITE                   0xA2
#define NFC7SPI_T2T_CMD_SECTOR_SELECT           0xC2
#define NFC7SPI_T2T_ACK                         0x0A

#define NFC7SPI_T4T_RSP_COMPLETE_1              0x90
#define NFC7SPI_T4T_RSP_COMPLETE_2              0x00
#define NFC7SPI_T4T_CLA_NO_SECURE               0x00
#define NFC7SPI_T4T_INS_SELECT                  0xA4
#define NFC7SPI_T4T_P1_SELECT_BY_NAME           0x04
#define NFC7SPI_T4T_P2_ONLY_OCCURANCE           0x00
#define NFC7SPI_T4T_LE_RSP_MAY_PRESENT          0x00
#define NFC7SPI_T4T_PPSE_APDU                   "2PAY.SYS.DDF01"

#define NFC7SPI_ISO15693_FLAG_DR_HIGH           0x02
#define NFC7SPI_ISO15693_CMD_READ_SINGLE        0x20
#define NFC7SPI_ISO15693_CMD_WRITE_SINGLE       0x21
#define NFC7SPI_ISO15693_RSP_OK                 0x00

#define NFC7SPI_MFC_REQ_XCHG_DATA               0x10
#define NFC7SPI_MFC_REQ_SECTOR_SEL              0x32
#define NFC7SPI_MFC_REQ_AUTHENTICATE            0x40
#define NFC7SPI_MFC_KEY_SELECTOR_A_EMB          0x10
#define NFC7SPI_MFC_CMD_READ                    0x30
#define NFC7SPI_MFC_CMD_WRITE                   0xA0
#define NFC7SPI_MFC_ACK                         0x0A

#define NFC7SPI_NCI_CORE_TOTAL_DURATION_510MS   { 0x01, 0x00, 0x02, 0xFE, 0x01 }
#define NFC7SPI_NCI_CORE_TAG_DETECTOR_DIS       { 0x01, 0xA0, 0x40, 0x01, 0x00 }
#define NFC7SPI_NCI_CORE_CLOCK_SEL_XTAL         { 0x01, 0xA0, 0x03, 0x01, 0x08 }
#define NFC7SPI_NCI_CORE_PMU_IRQ_EN_TVDD_3V3    { 0x01, 0xA0, 0x0E, 0x0B, 0x11, 0x01, 0x01, 0x01, \
                                                  0x00, 0x00, 0x00, 0x10, 0x00, 0xD0, 0x0C }
#define NFC7SPI_NCI_CORE_RF_CONF                { 0x09, \
                                                  0xA0, 0x0D, 0x03, 0x78, 0x0D, 0x02, \
                                                  0xA0, 0x0D, 0x03, 0x78, 0x14, 0x02, \
                                                  0xA0, 0x0D, 0x06, 0x4C, 0x44, 0x65, 0x09, 0x00, 0x00, \
                                                  0xA0, 0x0D, 0x06, 0x4C, 0x2D, 0x05, 0x35, 0x1E, 0x01, \
                                                  0xA0, 0x0D, 0x06, 0x82, 0x4A, 0x55, 0x07, 0x00, 0x07, \
                                                  0xA0, 0x0D, 0x06, 0x44, 0x44, 0x03, 0x04, 0xC4, 0x00, \
                                                  0xA0, 0x0D, 0x06, 0x46, 0x30, 0x50, 0x00, 0x18, 0x00, \
                                                  0xA0, 0x0D, 0x06, 0x48, 0x30, 0x50, 0x00, 0x18, 0x00, \
                                                  0xA0, 0x0D, 0x06, 0x4A, 0x30, 0x50, 0x00, 0x08, 0x00 }

#define NFC7SPI_MAX_NCI_FRAME_SIZE              258
#define NFC7SPI_TIMEOUT_INFINITE                0
#define NFC7SPI_TIMEOUT_100MS                   100
#define NFC7SPI_TIMEOUT_1S                      1000
#define NFC7SPI_TIMEOUT_2S                      2000

#define NFC7SPI_SET_DATA_SAMPLE_EDGE            SET_SPI_DATA_SAMPLE_EDGE
#define NFC7SPI_SET_DATA_SAMPLE_MIDDLE          SET_SPI_DATA_SAMPLE_MIDDLE
 // nfc7spi_set



#define NFC7SPI_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.ven  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.irq  = MIKROBUS( mikrobus, MIKROBUS_INT )
 // nfc7spi_map // nfc7spi

typedef struct
{
    uint8_t sens_res[ 2 ];
    uint8_t nfc_id_len;
    uint8_t nfc_id[ 10 ];
    uint8_t sel_res_len;
    uint8_t sel_res[ 1 ];
    uint8_t rats_len;
    uint8_t rats[ 20 ];
 
} nfc7spi_rf_intf_info_app_t;

typedef struct
{
    uint8_t sens_res_len;
    uint8_t sens_res[ 12 ];
    uint8_t attrib_res_len;
    uint8_t attrib_res[ 17 ];
 
} nfc7spi_rf_intf_info_bpp_t;

typedef struct
{
    uint8_t bitrate;
    uint8_t sens_res_len;
    uint8_t sens_res[ 18 ];
 
} nfc7spi_rf_intf_info_fpp_t;

typedef struct
{
    uint8_t afi;
    uint8_t dsf_id;
    uint8_t id[ 8 ];
 
} nfc7spi_rf_intf_info_vpp_t;

typedef union
{
    nfc7spi_rf_intf_info_app_t nfc_app;
    nfc7spi_rf_intf_info_bpp_t nfc_bpp;
    nfc7spi_rf_intf_info_fpp_t nfc_fpp;
    nfc7spi_rf_intf_info_vpp_t nfc_vpp;
 
} nfc7spi_rf_intf_info_t;

typedef struct
{
    uint8_t intf;                   
    uint8_t protocol;               
    uint8_t mode_tech;              
    uint8_t more_tags;              
    nfc7spi_rf_intf_info_t info;    
 
} nfc7spi_rf_intf_t;

typedef struct
{
    uint8_t msg_type;               
    uint8_t gid;                    
    uint8_t oid;                    
    uint8_t payload_len;            
    uint8_t payload[ NFC7SPI_MAX_NCI_FRAME_SIZE - 3 ];  
 
} nfc7spi_pkt_ctrl_t;

typedef struct
{
    uint8_t cid;                    
    uint8_t payload_len;            
    uint8_t payload[ NFC7SPI_MAX_NCI_FRAME_SIZE - 3 ];  
 
} nfc7spi_pkt_data_t;

typedef struct
{
    // Output pins
    digital_out_t ven;              
 
    // Input pins
    digital_in_t irq;               
 
    // Modules
    spi_master_t spi;               
 
    pin_name_t chip_select;         
 
    nfc7spi_pkt_ctrl_t pkt_ctrl;    
    nfc7spi_pkt_data_t pkt_data;    
    uint8_t cmd[ NFC7SPI_MAX_NCI_FRAME_SIZE ];  
    uint8_t rsp[ NFC7SPI_MAX_NCI_FRAME_SIZE ];  
    uint16_t rsp_len;               
 
    uint8_t fw_version[ 3 ];        
    uint8_t next_tag_protocol;      
 
} nfc7spi_t;

typedef struct
{
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
 
    pin_name_t ven;                 
    pin_name_t irq;                 
 
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
 
} nfc7spi_cfg_t;

typedef enum
{
    NFC7SPI_OK = 0,
    NFC7SPI_ERROR = -1
 
} nfc7spi_return_value_t;


void nfc7spi_cfg_setup ( nfc7spi_cfg_t *cfg );

err_t nfc7spi_init ( nfc7spi_t *ctx, nfc7spi_cfg_t *cfg );

err_t nfc7spi_default_cfg ( nfc7spi_t *ctx );

void nfc7spi_enable_device ( nfc7spi_t *ctx );

void nfc7spi_disable_device ( nfc7spi_t *ctx );

void nfc7spi_reset_device ( nfc7spi_t *ctx );

uint8_t nfc7spi_get_irq_pin ( nfc7spi_t *ctx );

err_t nfc7spi_tx ( nfc7spi_t *ctx, uint8_t *data_in, uint16_t len );

err_t nfc7spi_rx ( nfc7spi_t *ctx, uint8_t *data_out, uint16_t *len, uint16_t timeout );

err_t nfc7spi_trx ( nfc7spi_t *ctx, uint8_t *data_in, uint16_t in_len, uint8_t *data_out, uint16_t *out_len );

err_t nfc7spi_pkt_ctrl_tx ( nfc7spi_t *ctx, nfc7spi_pkt_ctrl_t *pkt );

err_t nfc7spi_pkt_ctrl_rx ( nfc7spi_t *ctx, nfc7spi_pkt_ctrl_t *pkt, uint16_t timeout );

err_t nfc7spi_pkt_ctrl_trx ( nfc7spi_t *ctx, nfc7spi_pkt_ctrl_t *pkt );

err_t nfc7spi_pkt_data_tx ( nfc7spi_t *ctx, nfc7spi_pkt_data_t *pkt );

err_t nfc7spi_pkt_data_rx ( nfc7spi_t *ctx, nfc7spi_pkt_data_t *pkt, uint16_t timeout );

err_t nfc7spi_pkt_data_trx ( nfc7spi_t *ctx, nfc7spi_pkt_data_t *pkt );

err_t nfc7spi_core_reset ( nfc7spi_t *ctx );

err_t nfc7spi_core_init ( nfc7spi_t *ctx );

err_t nfc7spi_core_standby ( nfc7spi_t *ctx, uint8_t mode );

err_t nfc7spi_core_total_duration ( nfc7spi_t *ctx );

err_t nfc7spi_core_tag_detector ( nfc7spi_t *ctx );

err_t nfc7spi_core_clock_sel ( nfc7spi_t *ctx );

err_t nfc7spi_core_pmu ( nfc7spi_t *ctx );

err_t nfc7spi_core_rf_config ( nfc7spi_t *ctx );

err_t nfc7spi_config_settings ( nfc7spi_t *ctx );

err_t nfc7spi_map_rf_interface ( nfc7spi_t *ctx );

err_t nfc7spi_start_discovery ( nfc7spi_t *ctx );

err_t nfc7spi_stop_discovery ( nfc7spi_t *ctx );

err_t nfc7spi_wait_discovery ( nfc7spi_t *ctx, nfc7spi_rf_intf_t *rf_intf );

void nfc7spi_presence_check ( nfc7spi_t *ctx, nfc7spi_rf_intf_t *rf_intf );

err_t nfc7spi_reader_act_next ( nfc7spi_t *ctx, nfc7spi_rf_intf_t *rf_intf );

err_t nfc7spi_reader_re_act ( nfc7spi_t *ctx, nfc7spi_rf_intf_t *rf_intf );

err_t nfc7spi_reader_tag_cmd ( nfc7spi_t *ctx, nfc7spi_pkt_data_t *pkt );
 
#ifdef __cplusplus
}
#endif
#endif // NFC7SPI_H
 // nfc7spi
 
// ------------------------------------------------------------------------ END